extends DirectoryResource
This is the root folder for e-learning. Its direct children are all programs in the current website. You can use this to find programs and courses available for the current user, or all which exist.
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| programFolders | List | Return all programs, as ProgramFolder resources in a ResourceList | |
| availPrograms | List | Find all programs available to the current user | |
| availModules | ResourceList | ||
| bestCourse | CourseFolder | Find the best course for the current user. If there is a currentCoursePath and that points to a completable course, return that. Otherwise attempt to locate a best program and return the first course. | |
| bestProgram | ProgramFolder | Locate the first available program, or the one selected by the program cookie | |
| cookieProgram | String | Returns the value of the program cookie - currentProgram - ie a program code | |
| name | String | ||
| orgModuleStats | OrgModulesStats | Get the stats for the current user's primary organisation for all programs | |
| completedModules | ResourceList | Returns modules which have been completed by the current user | |
| startedModules | ResourceList | Returns modules which have been started by the current user, which includes those which have been finished | |
| startedCourses | ResourceList | ||
| mostRecentCompletedModule | ModuleFolder | ||
| mostRecentCertificate | ModuleFolder | ||
| suggestedModule | ModuleFolder | The module that the current user should proceed with. If there is an incomplete module then this will return the most recent. Otherwise will return the first available to start. | |
| firstAvailableModule | ModuleFolder | Get the first module is not complete from an available course | |
| mostRecentModule | ModuleFolder | Returns the most recently access module, based on the modified date of ModuleStatus learning records | |
| modulesByCompletions | List | Get a list of all ModuleFolders which have at least 1 completion, with their corresponding number of completions | |
| coursesByCompletions | List | Get a list of all CourseFolder which have at least 1 completion, with their corresponding number of completions | |
| inProgressModules | List |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| findModule ( prog, course, moduleCode ) | ModuleFolder | ||
| getModulesByCompletions ( ) | List | Get a list of all ModuleFolders which have at least 1 completion, with their corresponding number of completions | |
| getCoursesByCompletions ( ) | List | Get a list of all CourseFolder which have at least 1 completion, with their corresponding number of completions |
Hide comments
